Skip to content
This repository was archived by the owner on Aug 30, 2024. It is now read-only.

Template updates#391

Merged
ricellis merged 6 commits intomasterfrom
template-updates
Jun 20, 2018
Merged

Template updates#391
ricellis merged 6 commits intomasterfrom
template-updates

Conversation

@ricellis
Copy link
Copy Markdown
Member

Thanks for your hard work, please ensure all items are complete before opening.

What

Updated issue and PR templates and contributing file.

@ricellis ricellis added this to the 2.next milestone Jun 19, 2018
@ricellis ricellis self-assigned this Jun 19, 2018
@ricellis ricellis requested a review from emlaver June 19, 2018 12:49
Copy link
Copy Markdown
Contributor

@emlaver emlaver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple small fixes

Comment thread .github/ISSUE_TEMPLATE.md Outdated
1. Initialize client
2. List DBs

cc = new CloudantClient(...)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This need to be updated to something like:

client = Cloudant(...)
dbs = client.all_dbs()

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well the idea was that this example was the same pseudo-code in every repo so we didn't have to update it all the time. If you think that is too confusing we can do a similar thing to the snippets for versions and update it to something in keeping with the code in each repo.

I think the idea though is to show people what kind of code sample to provide, not how to use the specific lib.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ricellis Yea makes sense, let's keep it as pseudo-code. Disregard the similar comments in the PRs of the other libraries.

Comment thread .github/ISSUE_TEMPLATE.md Outdated
- Version(s) that are affected by this issue.
> 2.0.2
- Python version
>3.6.2
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add space between > and 3.6.2.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in eba45bb

@ricellis ricellis merged commit d15ea51 into master Jun 20, 2018
@ricellis ricellis deleted the template-updates branch June 20, 2018 16:01
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants